home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 March / EnigmA AMIGA RUN 05 (1996)(G.R. Edizioni)(IT)[!][issue 1996-03][Skylink CD IV].iso / earcd / comm2 / ftp-mail.lha / FTP-Mail / ftp-mail.doc < prev    next >
Text File  |  1995-11-26  |  20KB  |  554 lines
  1. ----------------------------------------------------------------------------
  2.  
  3.     Für die deutsche Anleitung benutze Kommando "HELP ftp-mail.dok"!
  4.  
  5.     For most important Helpfiles from FTP-MAIL use the command "HELPALL".
  6.  
  7.     Write an EMail to  ftp@<domain>
  8.     with Subject or text             HELPALL
  9.  
  10. ----------------------------------------------------------------------------
  11. FTP-MAIL.DOC
  12.  
  13.  
  14.   (c) 1994 by Alexander Aulbach
  15.   (c) 1995 by Marc Stuermer (for additional artwork ;)
  16.  
  17.   Disclaimer: See Disclaimer.doc! Use command "HELP disclaimer.doc" to get
  18.   it via ftp-mail!
  19.  
  20.  
  21. ----------------------------------------------------------------------------
  22.  
  23.   PLESE EXKUSE MEI BÄD ENGLISCH!!!
  24.  
  25. ----------------------------------------------------------------------------
  26.  
  27.  
  28. Important notice:
  29. -----------------
  30.  
  31.   Be careful with this program! It is possible to send very large e-mails
  32.   with this program! The costs of sending such big e-mail could be very
  33.   large for the sysops of the domains before you!
  34.  
  35.   NEVER MISUSE THIS PROGRAM FOR CREATING FLAME-MAILS, BOMB-MAILS OR SUCH
  36.   THINGS!
  37.  
  38.  
  39. ----------------------------------------------------------------------------
  40.  
  41. What is it?
  42. -----------
  43.  
  44.   FTP-MAIL is a program to transfer automatically files via e-mail. I. e.
  45.   that you can order archives and other stuff via e-mail.
  46.  
  47.   FTP-MAIL is programmed for sites, which have special files available (e.g.
  48.   some special CD-ROMS, or - as me - a large amount of samples) and want to
  49.   make them available for everyone, but don't want to run the computer as a
  50.   BBS, but have an e-mail connect to the usenet (or other uucp-networks).
  51.  
  52.   FTP-MAIL was made for BBS's, which want to give the users a special
  53.   service. Normally it is a fact, that in the region of the BBS some
  54.   telefon-charges are left for every poll of the newsgroups. These free
  55.   charges could be used with ftp-mail.
  56.  
  57.   FTP-MAIL was even made for the transfer of help-files. So it could be a
  58.   good idea for a UUCP-system to install this daemon for the subdomains,
  59.   that they can get the newest information about your system and some help
  60.   for new users.
  61.  
  62. ----------------------------------------------------------------------------
  63.  
  64.  
  65. Basic things:
  66. -------------
  67.  
  68.  
  69. o E-MAIL-ADDRESS:
  70.   FTP-MAIL responds to e-mails, which you are sending to the program!
  71.  
  72.   If you send an e-mail to the system, you can use the following users:
  73.  
  74.   ftp, ftp-mail, mail-server and ftp-mail-server.
  75.  
  76.   Example-address: ftp-mail@ssilkyway.incubus.sub.org
  77.  
  78.   FTP-MAIL uses the Reply-To-adress "ftp-mail-daemon", because in special
  79.   cases there are two daemons, which sends all the time mails to the other
  80.   daemon.
  81.  
  82. o LOGFILE:
  83.   FTP-MAIL always sends back a logfile with your ORIGINAL MAIL and all
  84.   actions you have done and how they have been interpreted.
  85.  
  86.   EXCEPTION 1: If FTP-MAIL finds the command NOLOGFILE it will suppress the
  87.                sending of the logfile.
  88.  
  89.   EXCEPTION 2: After a PUT-command only the next 2 lines will be sended,
  90.                then this sendback will be aborted!
  91.  
  92.   EXCEPTION from EXCEPTION 1: If an error occurs.
  93.  
  94.   For every successful command HELP, DIR, LIST, LS and GET you will get an
  95.   extra e-mail!
  96.  
  97.  
  98. o HOW FTP-MAIL READS YOUR E-MAIL:
  99.   FTP-MAIL scans the whole mail! Even the header and the signature are
  100.   scanned. So be careful with your (perhaps randomly created) signature.
  101.   With the END-command you could avoid this.
  102.  
  103.   If the "Subject:"-line contents commands, they will also be interpreted
  104.   (see ALIASES)!
  105.  
  106.   Upper- and lowercase doesn't matter. FTP-MAIL converts all commands to
  107.   UPPERCASE.
  108.  
  109.   FTP-MAIL scans lines upto a length of 64 kB - this is the maximum length
  110.   of an ARexx-string.
  111.  
  112.  
  113. o HOW FTP-MAIL INTERPRETS:
  114.   FTP-MAIL understands only commands and arguments, like this:
  115.  
  116.   <command> <argument>
  117.     ^^^         ^^^
  118.   First word   Rest of the line (after the whitespaces) is taken as argument!
  119.  
  120.   Example: help ftp-paths.config
  121.  
  122.   A command must be the first word of a line. A word consists of one or
  123.   more chars, the words are separated by whitespace (SPACE or TAB).
  124.  
  125.   Spaces at the left or right of the argument are deleted!
  126.  
  127.   FTP-MAIL is looking only for these commands! Otherwise the complete line
  128.   is ignored (exceptions are aliases).
  129.  
  130.   PS: You can use quotes (<">) in the argument. They will be translated for
  131.       the DOS-scripts to <*">!
  132.       EXAMPLE: GET Usr:sounds/effects/Alex' cry
  133.                GET Usr:sounds/voices/Say "Aaaaaah"
  134.  
  135.  
  136. o COMMAND DELIMITERS:
  137.   FTP-MAIL ist looking for ";" (ASCII 124) in a line. This sign is the command
  138.   delimiter. This signs works like a new line to ftp-mail. You can put as
  139.   many commands in a line as you want (up to 65536 chars per line).
  140.  
  141.   EXCEPTION: After a PUT or END-command is found the rest of the mail/line
  142.              will not be scanned any more!
  143.  
  144.  
  145. o HOW ALIASES WORK:
  146.   If a command is unknown, FTP-MAIL will look in the "ftp-alias.config"
  147.   for aliases. They are replaced in the form:
  148.  
  149.   <oldcommand> <oldargument>
  150.   <newcommand> <newargument> <oldargument>
  151.  
  152.   Example:
  153.   SUBJECT: HELPALL                         -> will be replace with
  154.   HELPALL                                  -> will be replaced with
  155.   HELP | ALIASES | PATHS | MODES | MAXIMUM
  156.          vvvvvvv
  157.          ALIASES                           -> will be replaced with
  158.          HELP ftp-aliases.config
  159.  
  160.   and so on!
  161.  
  162.   You can get a full list of available aliases with the command "HELP
  163.   ftp-aliases.config" or just "ALIASES" - which is an alias to this command.
  164.   :-)
  165.  
  166.   Aliases could be more than one command (see command delimiter "|").
  167.  
  168.  
  169. o RESTRICTIONS:
  170.  
  171.   - FTP-MAIL executes only the first 500 commands (not lines!) of an e-mail
  172.     (I think this is enough :-).
  173.  
  174.   - Recursive aliases are not supported. The program stops with an error, the
  175.     FTP-postmaster will be informed.
  176.  
  177.   - The postmaster of the system can tell FTP-MAIL the maximum file-length
  178.     of the transferred file. You can get this maximum length with the command
  179.     "HELP ftp-maxtransfer.config" or just "MAXIMUM" OR "MAXTRANSFER".
  180.  
  181.   - There is no existing method at the moment to split large e-mail. :(
  182.  
  183.   - The postmaster of the system can also tell FTP-MAIL the domains, which
  184.     are allowed to get a ftp-mail. You can get this informations with the
  185.     command "HELP ftp-domains-lvl<X>.config", where <X> is a number between
  186.     0 and maximum integer.
  187.  
  188.     FTP-MAIL checks the receiver (Reply-To:) of the mails for a substring
  189.     from ftp-domains-lvl<X>.config.
  190.  
  191. o Security aspects
  192.  
  193.   The security of this program is and will be limited. IT IS POSSIBLE TO
  194.   ABUSE THIS PROGRAM WITH FAKED EMAIL-ADRESSES. This is the reason why 
  195.   the FTP-admin will get a copy of every logfile. But under normal 
  196.   circumstances this program is relative secure. It is running now over
  197.   one year on a large mailbox without problems. 
  198.  
  199. ----------------------------------------------------------------------------
  200.  
  201. Known Commands:
  202. ---------------
  203.  
  204. HELP   - Send SHORT help.
  205.  
  206. HELP   - HELP <filename>. Sends filename. The filename should end with
  207.          ".doc", ".config" or ".list", otherwise a ".doc" is added. A list
  208.          of other documentations about this daemon is included at the end of
  209.          this document (and any other HELP-request you will make)!
  210.          A specific help-file and the list of available files is sent only
  211.          once during a session.
  212.  
  213.          EXCEPTION: The list of the documentations will not be added if
  214.                     FTP-MAIL has found the NOFILEHELP-command.
  215.  
  216.          Example: HELP ftp-mail  ---> send this help-file (".doc" is
  217.                                       automatically added by default)
  218.                   HELP ftp-aliases.config
  219.                                  ---> sends config/ftp-aliases.config
  220.                                       ("config/" is automatically added if
  221.                                       not there and extention is ".config"!)
  222.                   HELP ftp-mail  ---> would not be sent, because it's just 
  223.                                       been sent in this session!
  224.  
  225. CD     - CD <full path>
  226.          CD <relative path>
  227.          Change Directory. The parameter gives the full path of the
  228.          directory you wish to change to. The path is checked for validity,
  229.          invalid CD-requests are fully ignored.
  230.  
  231.          Examples for full paths:
  232.  
  233.                     CD Usr:Sounds/cords
  234.                     CD USR:sounds/DRUMS/
  235.                     CD Usr:SOunds/Drums/Hihats/
  236.  
  237.          Examples for relative paths:
  238.          The first CD-command has to be a full path!
  239.  
  240.                   CD Usr:Sounds/cords
  241.                   CD /                  ---> path is now Usr:Sounds
  242.                   CD effects            ---> path is now Usr:Sounds/effects
  243.                   CD :                  ---> path is nor Usr:
  244.                                              (but not allowed and ignored, 
  245.                                              because not allowed in
  246.                                              ftp-paths.config!)
  247.  
  248.          The first CD-command must be a full path.
  249.  
  250.          You can get a full list of available paths with the command
  251.          "HELP ftp-paths.config" or just "PATHS" - which is an alias to this
  252.          command.
  253.  
  254.  
  255. LIST
  256. LS
  257. DIR    - LIST, LS, DIR
  258.          LIST <full path>, LS <full path>, DIR <full path>
  259.          You have to send a valid CD-command before you can list the
  260.          directory contents. You will get a list of all files in this
  261.          path.
  262.          It's shorter to overgive an argument to DIR, LS or LIST. In such
  263.          cases FTP-MAIL tries to make a CD-command first. This is the same
  264.          mechanism as in the GET-command.
  265.  
  266.          Examples:
  267.  
  268.          DIR
  269.            allritebeet                      axelerashenloop
  270.            Bongo-Snap                       Bongo-Snap.info
  271.            China-R-C                        China-R-H
  272.            China-Rythm                      digunddoof
  273.          ...
  274.  
  275.          LS
  276.          -----rwed      82    41284 Dez 23  1991 Usr:Sounds/Beats/allritebeet
  277.          /* Rythmus */
  278.          -----rwed      27    13492 Aug 10  1992 Usr:Sounds/Beats/Bongo-Snap
  279.          /* Rythmus */
  280.          -----rwed      98    49452 Jan 11  1994 Usr:Sounds/Beats/China-R-C
  281.          /* Rythmus */
  282.          -----rwed      98    49432 Jan 11  1994 Usr:Sounds/Beats/China-R-H
  283.          /* Rythmus */
  284.          ...
  285.          Totals:
  286.          Dirs:0    Files:41   Blocks:2015  Bytes:1017158
  287.  
  288.          LIST
  289.          09-Feb-92     20280  "Usr:Sounds/Beats/Hypnotist"  Rythmus
  290.          17-Dez-91     42732  "Usr:Sounds/Beats/Hypnotist hart"  Rythmus
  291.          10-Aug-92       494  "Usr:Sounds/Beats/Bongo-Snap.info"  Rythmus
  292.          17-Dez-91     15104  "Usr:Sounds/Beats/Loop 1"  Rythmus
  293.          17-Dez-91     25028  "Usr:Sounds/Beats/loop 1 131Bpm"  Rythmus
  294.          17-Dez-91     25408  "Usr:Sounds/Beats/Loop 10"  Rythmus
  295.          17-Dez-91     14788  "Usr:Sounds/Beats/Loop 2"  Rythmus
  296.          17-Dez-91     27536  "Usr:Sounds/Beats/loop 2 128Bpm"  Rythmus
  297.          17-Dez-91     25432  "Usr:Sounds/Beats/Loop 3"  Rythmus
  298.          ...
  299.  
  300.  
  301.          It is possible to take an argument as path for DIR, LS OR LIST.
  302.          In such a case FTP-MAIL tries to make CD <argument> before sending
  303.          the list (it's just nearly the same as with the GET-command)!
  304.  
  305.  
  306. LISTALL
  307. LSALL
  308. DIRALL - LISTALL, LSALL, DIRALL
  309.          LISTALL <full path>, LSALL <full path>, DIRALL <full path>
  310.          These are the same commands like above, but the subdirectories
  311.          are listed recursively.
  312.          
  313.          EXAMPLE for DIR:
  314.          Beats (dir)
  315.          allritebeet                      axelerashenloop
  316.          beat1                            beat10
  317.          beat2                            beat3
  318.          ...
  319.          
  320.          
  321. MODE   - MODE <mode>.
  322.          The mode tells the daemon which programms are called before the
  323.          mail is sent (or uploaded).
  324.  
  325.          Example:  MODE LHA-UUENCODE
  326.  
  327.          Default mode is:  UUENCODE
  328.  
  329.          You can get a full list of available modes with the command "HELP
  330.          ftp-modes.config". With the command "MODES" you can get this file
  331.          and the script-files, which represents the modes.
  332.  
  333.          It is possible to change the mode during a session as often as
  334.          you want. The GET and PUT-commands refers only to the last sended
  335.          MODE-command. This has sence depending which kind of file will be
  336.          sent.
  337.  
  338.  
  339. GET    - Get <filename>
  340.          Get <full path><filename>
  341.          You have to send a valid CD-command before you can get files or you
  342.          must tell the get command a full path (Note: the first scan-routine
  343.          decides if it is a full path, when a ":" is in the parameter!)
  344.  
  345.          If a file was sent successfully in one session, it will not
  346.          be sent again.
  347.          
  348.          ATTENTION: Due to historical reasons every command 
  349.                     GET <full path> <filename> will be replaced 
  350.                     internally into two commands (CD <full path> and
  351.                     GET <filename>). Please think about this. Once you
  352.                     set up a path, it will be valid until the next
  353.                     _valid_ CD-command.
  354.  
  355.          Example:  GET Usr:sounds/Beats/honey nut loops
  356.                    GET loop 2 | # the path consists
  357.                    GET Usr:Sounds/drums/woods/Block
  358.  
  359.          The file is encoded with -> MODE. You will get an e-mail with this
  360.          coded file.
  361.          You can get a full list of available modes with the command
  362.          "HELP ftp-modes.config" or just "MODES" - which is a alias to this
  363.          command.
  364.  
  365.          Please take a look into the e-mail-header, which is sent back to
  366.          you. Everything you need to extract it automatically is in the
  367.          X-... headers! I have implemented the command in this way that it 
  368.          is possible to send a mail (that you have got from another site 
  369.          with FTP-MAIL) as a PUT-command to your ftp-mail-daemon (with less
  370.          afford - changing the X-Path: - adding NOLOGFILE...!).
  371.  
  372.  
  373. PUT    - This is a special command!
  374.          If you want to send something to this system you have to put some
  375.          special-lines to your mail!
  376.  
  377.          You MUST specify the following lines anywhere in the mail:
  378.                X-PATH:        <path which must exist in ftp-upload-paths.config>
  379.                X-NAME:        <name of the file>
  380.                X-COMMENT:     <filecomment to this file>
  381.                X-LENGTH:      <original-length>
  382.  
  383.          FTP-MAIL CAN ACCESS ONLY ONE PUT-COMMAND PER SESSION (E-MAIL)!
  384.          Everything AFTER the PUT-command is dropped and will not be
  385.          executed (FTP-MAIL assumes, that the file you want to send to the
  386.          daemon is normally beginning directly behind the PUT-command).
  387.  
  388.          For the moment only uuencoded files (see MODES!) could be sent.
  389.          X-LENGTH is in this case the length of the file BEFORE/AFTER
  390.          uuen/decoding!
  391.  
  392.  
  393.  
  394. Other keywords/commands:
  395.  
  396. END         - The rest of the e-mail will not be read. Good for
  397.               random-signatures.
  398.  
  399. NOLOGFILE   - I think this is easy to understand! This command supresses the
  400.               sending of the logfile.
  401.  
  402.               EXCEPTION: If a bigger error occurs (FTP-MAIL got in trouble)
  403.                          the logfile is sent back!
  404.  
  405.  
  406. NOFILEHELP  - This command supresses the appending of the list of existing
  407.               helpfiles at the end of the first helpfile.
  408.  
  409.  
  410. MESSAGE-ID: - if you send more than one mail per day to the daemon. You can
  411.               see, which logfile belongs to the referencing mail.
  412.               This command is only evaluated once, because more than one
  413.               MESSAGE-ID: in a mail makes no sense!
  414.  
  415. DATE:       - date of your posting. This command is only evaluated once.
  416.  
  417. FROM:       - Default reply-address (if REPLY-TO: is not given)
  418.  
  419. REPLY-TO:   - Reply address. This is good to send your mails not back to your
  420.               normal mailfolder. Example:
  421.  
  422.               REPLY ftpget@ssilkyway.mayn.sub.de
  423.               ^^^^^
  424.               --> "REPLY-TO:" has the alias "REPLY"!
  425.               FTP-MAIL takes always the last found REPLY-TO:-address for the
  426.               whole mail.
  427.  
  428.               If REPLY-TO: is not found it will take the FROM:-argument. If
  429.               FROM: is also not found an error occurs.
  430.  
  431.  
  432. empty lines
  433. #           - comments, which are not evaluated.
  434.  
  435.               Example:   # this is only a silly comment
  436.  
  437.                          # ^^^ this line before too! :-)
  438.  
  439.  
  440. Only in context with PUT-command:
  441.  
  442. X-PATH:     - path which must exist in ftp-upload-paths.config
  443.  
  444. X-NAME:     - name of the file
  445.  
  446. X-COMMENT:  - filecomment to this file
  447.  
  448. X-LENGTH:   - original-length
  449.  
  450.  
  451. ----------------------------------------------------------------------------
  452.  
  453. Important aliases:
  454. ------------------
  455.  
  456. HELPALL     -> "HELP | HELPME | ALIASES | PATHS | MODES | MAXIMUM"
  457.  
  458.             This sends you the most important helpfiles!
  459.             See command delimiter above, to understand it!
  460.  
  461. HELPME      -> "HELP ftp-mail.doc"
  462.  
  463.             Send THIS Doc!
  464.  
  465. HILFMIR     -> "HELP ftp-mail.dok"
  466.  
  467.             Sende DEUTSCHE Dokumentation!
  468.  
  469. ALIASES     -> "HELP ftp-aliases.config"
  470.  
  471.             This command sends you the alias-list. There could be
  472.             user-defined aliases in it (e.g. sending a list of all files,
  473.             available on this site).
  474.  
  475. PATHS       -> "HELP ftp-paths.config"
  476.  
  477.             Sends a list of all available paths you can get files from
  478.             (only level-0 users!).
  479.  
  480. MODES       -> "HELP ftp-modes.config | HELP config/.uuencode.list | HELP
  481.                 config/.lha-uencode.list | HELP config/.raw.list | HELP
  482.                 config/.uudecode.list"
  483.  
  484.             Sends a list of all available modes and the script-files
  485.             belonging to the modes. The modes and what they do are
  486.             described in this list. The names after the modes are
  487.             the DOS-scripts which are called to execute the modes.
  488.  
  489. MAXIMUM     or
  490. MAXTRANSFER -> "HELP ftp-maxtransfer.config"
  491.  
  492.              Sends the maximal length of a GET-request. GET will not work,
  493.              if a file is bigger than this.
  494.  
  495. REPLY       -> "REPLY-TO:"
  496.  
  497.             Used as an easier alias for the REPLY-TO: keyword.
  498.  
  499. SUBJECT:    -> ""
  500.  
  501.             This replaces the subject-command with nothing! See
  502.             replacement of aliases above, to understand it.
  503.             With this alias you can write commands in the subject-line!
  504.  
  505.  
  506. ----------------------------------------------------------------------------
  507.  
  508. Example e-mail:
  509. ---------------
  510.  
  511.  
  512. > From ssilk Sat, 20 Aug 94 11:36:49 CED
  513. > Received: by ssilkyway.mayn.sub.de (wUUCP 1.10)
  514. >       id <05bn@ssilkyway.mayn.sub.de>; Sat, 20 Aug 94 11:36:49 CED
  515. > Date: Sat, 20 Aug 94 11:36:49 CED
  516. > Message-Id: <9408201135.05bn@ssilkyway.mayn.sub.de>
  517. > X-Mailer: //\\miga Electronic Mail (AmiElm 2.253)
  518. > X-PATH: Usr:ftp-mail
  519. > X-NAME: readme.doc
  520. > X-COMMENT: The readme to FTP-MAIL-DAEMON
  521. > X-LENGTH: 405
  522. > Organization: Semmelstreet
  523. > Reply-To: ssilk@ssilkyway.mayn.sub.de
  524. > Content-Length: 692
  525. > From: ssilk@ssilkyway.mayn.sub.de (Alexander Aulbach)
  526. > To: ssilkftp@ssilkyway.mayn.sub.de
  527. > Subject: HELPALL
  528. >
  529. > GET usr:sounds/beats/loop 4
  530. >
  531. > List | PUT | REPLY ftp_receiver@ssilkyway
  532. > MODE RAW ; GET loop 2
  533. >
  534. > begin 777 readme.doc
  535. > M"@I214%$344M1DE24U0N1$]#"@I7:&%T(&ES(&ET/PHM+2TM+2TM+2TM+0H*X
  536. > M1E10+4U!24P@:7,@82!P<F]G<F%M('1O('1R86YS9F5R(&%U=&]M871I8V%LX
  537. > M;'D@9FEL97,@=FEA($4M36%I;"X@22X@92X@=&AA= IY;W4@8V%N(&]R9&5RX
  538. > M(&%R8VAI=F5S(&%N9"!O=&AE<B!S='5F9B!V:6$@12U-86EL+@H*1E10+4U!X
  539. > M24P@:7,@979E;B!T:&]U9VAT(&9O<B!T<F%N<V9E<B!O9B!H96QP+69I;&5SX
  540. > M+B!3;R!I="!C;W5L9"!B92!A(&=O;V0*:61E82!F;W(@82!554-0+7-Y<W1EX
  541. > M;2!T;R!I;G-T86QL('1H:7,@9&%E;6]N(&9O<B!T:&4@<W5B9&]M86EN<RP@X
  542. > M=&AA="!T:&5Y"F-A;B!G970@=&AE(&YE=V5S="!I;F9O<FUA=&EO;B!A8F]UX
  543. > M="!Y;W5R('-Y<W1E;2!A;F0@<V]M92!H96QP(&9O<B!N97<*=7-E<G,N"@H*X
  544. >  X
  545. > end
  546. >
  547. >
  548.  
  549.  
  550. The REPLY, MODE and GET-command will not be executed, because all commands
  551. after the PUT-command will not be read.
  552.  
  553.  
  554. Have much fun with FTP-MAIL!